<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
	<meta http-equiv="Content-Type" content="text/html; charset=UTF-8" />
	<title>oak-repeat-query: openark kit documentation</title>
	<meta name="description" content="oak-repeat-query: openark kit" />
	<meta name="keywords" content="oak-repeat-query: openark kit" />
	<link rel="stylesheet" type="text/css" href="style.css" />
</head>

<body>
	<div id="main">
		<div id="header">
			<h1>openark kit documentation</h1>
			<div class="subtitle">Common utilities for MySQL</div>
		</div>
		<div id="contentwrapper">
			<div id="content">
				<h2><a href="oak-repeat-query.html">oak-repeat-query</a></h2>	
<h3>NAME</h3>
oak-repeat-query: repeat query execution until some condition holds
<h3>SYNOPSIS</h3>
Repeat DELETE query until no more rows are affected, verbose:
<blockquote>oak-repeat-query --user=root --socket=/tmp/mysql.sock --database=sakila -e "DELETE FROM sakila.film_actor LIMIT 100" -v</blockquote>
Repeat UPDATE query until no more rows are affected, sleep <b>1</b> second between iterations, use defaults file:
<blockquote>oak-repeat-query --defaults-file=/home/myuser/.my-oak.cnf --database=sakila -e "UPDATE film SET title = LEFT(title, 20) WHERE CHAR_LENGTH(title) > 20" --sleep-time=1000 -v</blockquote>
Repeat a query for <b>200</b> times, sleep <b>1</b> second between iterations:
<blockquote>oak-repeat-query --defaults-file=/home/myuser/.my-oak.cnf --database=sakila -e "SELECT * FROM hot_table WHERE ts BETWEEN NOW() - INTERVAL 1 MINUTE AND NOW()" --sleep-time=1000 --max-iterations=200</blockquote>
Repeat a query for <b>2</b> minutes, sleep <b>1</b> second between iterations:
<blockquote>oak-repeat-query --defaults-file=/home/myuser/.my-oak.cnf --database=sakila -e "SELECT * FROM hot_table WHERE ts BETWEEN NOW() - INTERVAL 1 MINUTE AND NOW()" --sleep-time=1000 --max-seconds=120</blockquote>

<h3>DESCRIPTION</h3>
<p>This tool invokes given query until no more rows are affected, a number of iterations is reached, or certain time has passed.</p>
<p>Two required options for this tool are <b>--database</b> (database to connect to) and <b>--execute</b> (query to execute).</p>
<p><i>oak-repeat-query</i> terminates under the following conditions:</p>
<ul>
	<li>If <b>--max-iterations</b> is specified, and number of iteration exceeds given value, the tool terminates.</li>
	<li>If <b>--max-seconds</b> is specified, and the total runtime (including sleep time) exceeds given value, the tool terminates.</li>
	<li>If none of the above are defined, the tool terminates when no rows are affected by given query.</li>
	<li>If Ctrl-C is hit, the tool terminates.</li>
</ul>
<p>There is no cleanup code for termination.</p>

<h3>OPTIONS</h3>
--ask-pass
<p class="indent">Prompt for password.</p>

-d DATABASE, --database=DATABASE
<p class="indent">Database name (required)</p>
--debug
<p class="indent">Print stack trace on error.</p>

--defaults-file=DEFAULTS_FILE
<p class="indent">Read from MySQL configuration file. Overrides --user, --password, --socket, --port.</p>
<p class="indent">Configuration needs to be in the following format:</p>

<p class="indent"><strong>[client]<br/>
user=my_user<br/>
password=my_pass<br/>
socket=/tmp/mysql.sock<br/>
port=3306</strong>
</p>

-e EXECUTE_QUERY, --execute=EXECUTE_QUERY
<p class="indent">Query to execute (required)</p>

-H HOST, --host=HOST
<p class="indent">MySQL host (default: localhost)</p>

--max-iterations=MAX_ITERATIONS
<p class="indent">Maximum number of iterations to execute</p>

--max-seconds=MAX_SECONDS
<p class="indent">Maximum number of seconds (clock time) to run</p>
                        
-p PASSWORD, --password=PASSWORD
<p class="indent">MySQL password</p>

-P PORT, --port=PORT
<p class="indent">TCP/IP port (default: 3306)</p>

-s SLEEP_TIME, --sleep-time=SLEEP_TIME
<p class="indent">Number of milliseconds to sleep between query
executions (default: 0)</p>

--sleep-ratio=SLEEP_RATIO
<p class="indent">Ratio of sleep time to execution time. Default: 0</p>
                        
-S SOCKET, --socket=SOCKET
<p class="indent">MySQL socket file. Only applies when host is localhost</p>

-u USER, --user=USER
<p class="indent">MySQL user</p>

-v, --verbose
<p class="indent">Print user friendly messages</p>

<h3>ENVIRONMENT</h3>
Requires MySQL 5.0 or newer, python 2.3 or newer.

python-mysqldb must be installed in order to use this tool. You can
<blockquote>apt-get install python-mysqldb</blockquote>
or
<blockquote>yum install mysql-python</blockquote>
<h3>SEE ALSO</h3>
<p>oak-chunk-update</p>

<h3>LICENSE</h3>
This tool is released under the BSD license.
<blockquote><pre>Copyright (c) 2008 - 2010, Shlomi Noach
All rights reserved.

Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met:
* Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer.
* Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following disclaimer in the documentation and/or other materials provided with the distribution.
* Neither the name of the organization nor the names of its contributors may be used to endorse or promote products derived from this software without specific prior written permission.
THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR 
A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT 
LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR 
TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.</pre>
</blockquote>
<h3>AUTHOR</h3>
Shlomi Noach
				<br/>
			</div>
			<div id="sidebarwrapper">
				<div id="menu">
					<h3>openark kit tools</h3>
					<ul>
						<li><a title="Introduction" href="introduction.html">Introduction</a></li>
						<li><a title="Download" href="download.html">Download</a></li>
						<li><a title="Install" href="install.html">Install</a></li>
						<li><a title="oak-apply-ri" href="oak-apply-ri.html">oak-apply-ri</a></li>
						<li><a title="oak-block-account" href="oak-block-account.html">oak-block-account</a></li>
						<li><a title="oak-chunk-update" href="oak-chunk-update.html">oak-chunk-update</a></li>
						<li><a title="oak-get-slave-lag" href="oak-get-slave-lag.html">oak-get-slave-lag</a></li>
						<li><a title="oak-hook-general-log" href="oak-hook-general-log.html">oak-hook-general-log</a></li>
						<li><a title="oak-kill-slow-queries" href="oak-kill-slow-queries.html">oak-kill-slow-queries</a></li>
						<li><a title="oak-modify-charset" href="oak-modify-charset.html">oak-modify-charset</a></li>
						<li><a title="oak-online-alter-table" href="oak-online-alter-table.html">oak-online-alter-table</a></li>
						<li><a title="oak-prepare-shutdown" href="oak-prepare-shutdown.html">oak-prepare-shutdown</a></li>
						<li><a title="oak-purge-master-logs" href="oak-purge-master-logs.html">oak-purge-master-logs</a></li>
						<li><a title="oak-repeat-query" href="oak-repeat-query.html">oak-repeat-query</a></li>
						<li><a title="oak-security-audit" href="oak-security-audit.html">oak-security-audit</a></li>
						<li><a title="oak-show-limits" href="oak-show-limits.html">oak-show-limits</a></li>
						<li><a title="oak-show-replication-status" href="oak-show-replication-status.html">oak-show-replication-status</a></li>
					</ul>
				</div>
			</div>	
			<div class="clear">&nbsp;</div>
			
			<div id="footnote" align="center">
				<a href="">openark kit</a> documentation
			</div>
		</div>
	</div>
</body>
</html>
